home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1998 July / EnigmA AMIGA RUN 29 (1998)(G.R. Edizioni)(IT)[!][issue 1998-07 & 08].iso / recent / httx.lha / AWeb / HTTXPlugin.doc < prev    next >
Text File  |  1998-06-17  |  6KB  |  207 lines
  1.                                  HTTXPlugin
  2.  
  3.                    HTML to text conversion plugin for AWeb
  4.                              by Gabriele Favrin
  5.  
  6.  
  7. -----------------------------------------------------------------------------
  8. The author is in no way responsible for any damage that these programs may
  9. cause.
  10.  
  11. Redistribution or modification is forbidden. If you improve these scripts
  12. send me the new version at favrin@tin.it.
  13. -----------------------------------------------------------------------------
  14.  
  15.  
  16. Index:
  17.  
  18.   1. Introduction
  19.   2. Installation
  20.   3. Configuration
  21.   4. Usage
  22.   5. History
  23.  
  24.  
  25. 1. Introduction
  26. ---------------
  27.  
  28. With the HTTXPlugin you can use HTTX from within AWeb to save (or print) HTML
  29. pages as text. This version of the interface requires AWeb II 3.1 or better
  30. and HTTX 1.7 or better. Also, the command "Delete" must be present in C:
  31. directory.
  32.  
  33.  
  34. 2. Installation
  35. ---------------
  36.  
  37.   1. Copy all the following files:
  38.  
  39.      HTTXPlugin.awebrx
  40.      HTTXPluginCFG.awebrx
  41.      HTTXPluginPRT.awebrx
  42.      HTTX <-- yes, also the HTTX executable!
  43.      HTTXPlugin.doc.html
  44.  
  45.      To the AWeb/Plugins/HTTX directory.
  46.  
  47.   2. HTTX may be called from AWeb in several ways. You may want to use more
  48.      than one method. Possibly User button AND Frame Popup menu for save and
  49.      print with the HTTX configuration in the Arexx menu.
  50.  
  51.       - ARexx menu (GUI settings/ARexx)
  52.       - User buttons (Fastlinks) (GUI settings/Buttons)
  53.       - User definable keys (GUI settings/Keys)
  54.  
  55.      First three (menu, buttons, keys):
  56.  
  57.      You can add three entries, one for Save as text (HTTXPlugin.awebrx), one
  58.      for Print as text (HTTXPluginPRT.awebrx) and one for the HTTX and plugin
  59.      configuration (HTTXPluginCFG.awebrx).
  60.  
  61.      Popup menu (frame)
  62.  
  63.      Add the entries "Save As Text" and "Print As Text" (if required) using
  64.      the following commands.
  65.  
  66.      save:
  67.      RUN AWebPath:Plugins/HTTX/HTTXPlugin.awebrx TARGET %i
  68.  
  69.      print:
  70.      RUN AWebPath:Plugins/HTTX/HTTXPluginPRT.awebrx TARGET %i
  71.  
  72.      Now it will be possible to save or print a single frame directly from
  73.      the popup menu (without using the plugin "Select frames" function).
  74.  
  75.  
  76. 3. Configuration
  77. ----------------
  78.  
  79. Start HTTXPluginCFG.awebrx with AWeb to set the various options.
  80.  
  81.  
  82.                     HTML conversion related configuration
  83.  
  84. Default Directory
  85.    Default directory to save the converted files to.
  86.  
  87. Line length
  88.    Maximum length for each line. (option LEN)
  89.  
  90. Indentation
  91.    Indentation in spaces of <UL>, <OL> or <DL> lists. (option INDENT)
  92.  
  93. ANSI conversion of HTML styles and LINKS.
  94.    Conversion of HTML styles and LINKS (HREF and NAME) to ANSI sequences and
  95.    optimization of alignment functions. (option ANSI)
  96.  
  97. Conversion of HTML entities to 7 bit ascii
  98.    Conversion of HTML entities (accent letters, and so) to ASCII codes lower
  99.    than 128. (option 7BIT)
  100.  
  101. HR draw mode
  102.    Line drawing for <HR> tag. (option HRMODE=nn)
  103.  
  104.     - Off (no lines)
  105.     - ASCII (lines composed by "-")
  106.     - ANSI (lines composed by ANSI underlined spaces)
  107.  
  108. Ignore text and HR alignment
  109.    Don't center or right justify text and lines. (option NOALIGN)
  110.  
  111. Save Title as FileNote
  112.    Save the document title (<TITLE>) as the output files file comment. Only
  113.    used when saving as text. (option FILENOTE)
  114.  
  115. Suppress Title/URL
  116.    Suppresses insertion of document Title (<TITLE>) and URL in output file.
  117.    (option NOHEADER if set, GETNOTE if not set.)
  118.  
  119. Print HTML Link References
  120.    Add HTML link references to the converted file. (option HREF)
  121.  
  122. Print Image Alternate Texts
  123.    Add the ALT-text of images (<IMG>) to the output file. (option IMG)
  124.  
  125. Print JavaScript scripts
  126.    Add the text (NOT result!) of JavaScript (or other scripts) to converted
  127.    file. (option SCRIPT)
  128.  
  129. Support badly written HTML
  130.    Partial support for badly written HTML documents. Use with caution!
  131.    (option BADHTML)
  132.  
  133. The standard HTTX settings will be saved in the environment variables
  134. HTTX.prefs (for Save as text) and HTTXprt.prefs (for Print as text).
  135.  
  136. Other options (like FORCE or INCLUDE) are managed directly from the Plugin.
  137. Refer to HTTX documentation for a full explanation of options.
  138.  
  139.  
  140.                         Plugin related configuration
  141.  
  142. Print HTTP/META header
  143.    Add the HTTP header information and the <META> tags present in the HTML
  144.    source to the converted file.
  145.  
  146.    Example of the added text:
  147.  
  148.    Header:
  149.    HTTP/1.0 200 OK
  150.    Server: Netscape-Enterprise/2.01
  151.    Date: Sat, 26 Apr 1997 06:38:12 GMT
  152.    Accept-ranges: bytes
  153.    Last-modified: Tue, 15 Apr 1997 13:57:46 GMT
  154.    Content-length: 7085
  155.    Content-type: text/html
  156.    Content-Type: text/html; charset=ISO-8859-1
  157.  
  158. Show preview of converted document
  159.    After a document is converted it will be shown using MultiView (must be in
  160.    "SYS:Utilities/" drawer). After closing MultiView a requester will ask if
  161.    the document should be kept or deleted. Select Delete and the file will be
  162.    erased and no conversion informations will be shown.
  163.  
  164.    Note that some versions of MultiView seems to have problems with some of
  165.    the ANSI codes used by HTTX. If part of text not indented, don't worry, it
  166.    is MultiView. See HTTX documentation for more informations.
  167.  
  168.    This option is only used when saving as text.
  169.  
  170. Show conversion report
  171.    After converting a document, an info page containing the current HTTX
  172.    settings is normally shown. You can choose between this and a requester
  173.    that reports only if conversion has been successful.
  174.  
  175. The HTTX-AWeb settings are saved in the environment variable
  176. HTTXPlugin.config.
  177.  
  178. Saving preferences for HTTX works like the standard WB preference programs.
  179. Use the "Save" or "Use" option to store data. With "Save" the settings are
  180. stored in ENVARC: and the changes are permanent. With "Use" they are saved
  181. only in ENV: so changes are lost when you reboot. The first time you
  182. configure HTTX you MUST use "Save" option.
  183.  
  184.  
  185. 4. Usage
  186. --------
  187.  
  188. To save or print a page use the previously set menu or popup entries.
  189.  
  190. If page contains frames (or iframes) a requester will open. You may choose to
  191. save all frames to a single file or use a requester to save or skip each
  192. frame.
  193.  
  194. If preview is active when saving, after conversion of any document, the
  195. converted document will be shown and then the keep or delete requester will
  196. be shown.
  197.  
  198.  
  199. 5. History
  200. ----------
  201.  
  202. V2.1a
  203.  
  204.    - Fixed possible problems with file names containing spaces.
  205.  
  206. -----------------------------------------------------------------------------
  207.